Skip to content

🔧 add .python-version file and update README with Python version requirement for building docs #695

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jun 1, 2025

Conversation

azigler
Copy link
Collaborator

@azigler azigler commented Apr 21, 2025

While setting up the dev environment on Python 3.13 (default M2 Python version) I noticed the wheels dependency failed due to versioning support.

I added a file for a user's local pyenv to pick up the correct version for building the docs. I also included a note in the README:

image

✨ PR Description

Purpose and impact:
This PR updates the README and specifies Python version 3.10 for the local documentation server setup.

Main changes:

  • Added a .python-version file specifying Python 3.10
  • Updated README to clarify Python version requirement for local documentation server
  • Minor formatting and whitespace changes in the README

Generated by LinearB AI and added by gitStream.
AI-generated content may contain inaccuracies. Please verify before using. We'd love your feedback! 🚀

…irement for building docs
Copy link

@orca-security-us orca-security-us bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Orca Security Scan Summary

Status Check Issues by priority
Passed Passed Infrastructure as Code high 0   medium 0   low 0   info 0 View in Orca
Passed Passed SAST high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Secrets high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Vulnerabilities high 0   medium 0   low 0   info 0 View in Orca

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
gitstream-cm[bot]
gitstream-cm bot previously requested changes Apr 21, 2025
Copy link
Contributor

@gitstream-cm gitstream-cm bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have used local links, use www instead.

gitstream-cm[bot]
gitstream-cm bot previously requested changes Apr 21, 2025
Copy link
Contributor

@gitstream-cm gitstream-cm bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have used local links, use www instead.

Copy link
Contributor

gitstream-cm bot commented Apr 21, 2025

Please mark which AI tools you used for this PR by checking the appropriate boxes:

  • GitHub Copilot
  • Cursor
  • ChatGPT
  • Tabnine
  • JetBrains AI Assistant
  • VSCode IntelliCode
  • Claude
  • Gemini
  • Other AI tool
  • No AI tools were used

Tip: If you want to avoid this comment in the future, you can add a label of the format 🤖 ai-* when creating your PR.

Sorry, something went wrong.

@gitstream-cm gitstream-cm bot requested review from vim-zz, BenLloydPearson and a team April 21, 2025 19:59
gitstream-cm[bot]
gitstream-cm bot previously approved these changes Apr 21, 2025
@gitstream-cm gitstream-cm bot dismissed stale reviews from themself April 21, 2025 20:00

Review resolved

@azigler
Copy link
Collaborator Author

azigler commented Apr 21, 2025

@PavelLinearB FYI, I'm unable to respond to the microsurvey, it's uneditable for me.

@gitstream-cm gitstream-cm bot dismissed their stale review April 21, 2025 20:08

Review dismissed

@PavelLinearB
Copy link
Contributor

@PavelLinearB FYI, I'm unable to respond to the microsurvey, it's uneditable for me.

I think it's because you don't have write permissions to the repo.. We'll fix that

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
gitstream-cm[bot]
gitstream-cm bot previously approved these changes Apr 28, 2025
@gitstream-cm gitstream-cm bot dismissed their stale review April 28, 2025 22:45

Review dismissed

@azigler
Copy link
Collaborator Author

azigler commented Apr 28, 2025

@PavelLinearB The check_local_links automation is firing but it's a false positive because this is a README. Do we need to change the rule to not label *.md? Let me know how you'd like to fix.

Also, is check_local_links on the gitStream docs? I don't see an example of that there.

@PavelLinearB
Copy link
Contributor

@PavelLinearB The check_local_links automation is firing but it's a false positive because this is a README. Do we need to change the rule to not label *.md? Let me know how you'd like to fix.

Also, is check_local_links on the gitStream docs? I don't see an example of that there.

@azigler, This automation we added to protect our docs from internal links pointing to localhost, so it should be applied to README files. We should fix it to remove this false positive, and we can add it to our catalog.

@azigler
Copy link
Collaborator Author

azigler commented Apr 29, 2025

@PavelLinearB In this case, what's triggering the automation was already there (the URL for a user's locally built docs server) and I didn't add it. How do you recommend we point them to their localhost for their docs if we cannot use a local link? I can remove the URL but that feels less helpful.

@azigler azigler self-assigned this May 1, 2025

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Copy link
Contributor

@gitstream-cm gitstream-cm bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have used local links, use www instead.

This comment has been minimized.

azigler and others added 2 commits May 8, 2025 10:46

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
gitstream-cm[bot]
gitstream-cm bot previously requested changes May 29, 2025
Copy link
Contributor

@gitstream-cm gitstream-cm bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have used local links, use www instead.

gitstream-cm[bot]

This comment was marked as resolved.

gitstream-cm[bot]
gitstream-cm bot previously approved these changes May 29, 2025

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
gitstream-cm[bot]

This comment was marked as resolved.

@gitstream-cm gitstream-cm bot dismissed their stale review May 30, 2025 11:15

Review dismissed

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@vim-zz
Copy link
Collaborator

vim-zz commented May 31, 2025

@azigler I have changed the check so it ignore the specific REAME line, see #731

gitstream-cm[bot]

This comment was marked as resolved.

gitstream-cm[bot]
gitstream-cm bot previously approved these changes May 31, 2025
@gitstream-cm gitstream-cm bot dismissed their stale review May 31, 2025 07:01

Review dismissed

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Copy link
Contributor

@gitstream-cm gitstream-cm bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✨ PR Review

LGTM

Generated by LinearB AI and added by gitStream.
AI-generated content may contain inaccuracies. Please verify before using. We'd love your feedback! 🚀

gitstream-cm[bot]
gitstream-cm bot previously approved these changes May 31, 2025
@gitstream-cm gitstream-cm bot removed the wrong link label May 31, 2025
@gitstream-cm gitstream-cm bot dismissed stale reviews from themself May 31, 2025 07:27

Review resolved

@vim-zz vim-zz merged commit 92f0aef into linear-b:main Jun 1, 2025
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants